Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: README Documentation #2

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Feature: README Documentation #2

wants to merge 2 commits into from
+1 −3

Conversation

gaal1le0
Copy link
Contributor

@gaal1le0 gaal1le0 commented Dec 12, 2021 •
edited
Loading

Include all documentation needed to distribute this API.

@gaal1le0 gaal1le0 added documentation Improvements or additions to documentation dont-merge Good for newcomers feature New feature or request work-in-progress This issue or pull request already exists labels Dec 12, 2021
@gaal1le0 gaal1le0 added this to the v1.0.0 milestone Dec 12, 2021
@gaal1le0
Copy link
Contributor Author

@Alcazar87 you should start writing this README while you are working in new functionalities in the API. It's allow us to have the README updated with all needed content. Also, the API must be documented using Swagger as I explained you.

  • What is that?
  • What will be the main function of this micro service?
  • How can I use the micro service?
  • Communication procedures.

All must be in english.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DanBaDo DanBaDo DanBaDo approved these changes

@SamHDevv SamHDevv Awaiting requested review from SamHDevv

@Uxbel Uxbel Awaiting requested review from Uxbel

@Alcazar87 Alcazar87 Awaiting requested review from Alcazar87

At least 1 approving review is required to merge this pull request.

Assignees

@gaal1le0 gaal1le0

@Alcazar87 Alcazar87

Labels
documentation Improvements or additions to documentation dont-merge Good for newcomers feature New feature or request work-in-progress This issue or pull request already exists
Projects
None yet
Milestone
v1.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@gaal1le0 @DanBaDo @Alcazar87